Update ephemeral environment docs with automatic deployments #2871
Conversation
lourens-octopus
force-pushed
the
lourens/add-automatic-deployments-to-ee
branch
from
a9420bc to
34504bd
Compare
There was a problem hiding this comment.
@lourens-octopus is there a way to see changes in a branch? I'd like to take a look and run it through the guidelines.
|
|
||
| ### Manually | ||
|
|
||
| If manual deployments is selected, ephemeral environments can be created manually from the Ephemeral Environments page within the project. |
There was a problem hiding this comment.
In the Portal we don't call this "manual deployment" (at least as a heading/radio button), we say "Don't automatically deploy...", we should be consistent with the way we describe the various concepts here. Happy to workshop the copy and titles here to find the right way to describe if that would be helpful.
| - Select **Add Ephemeral Environment** from the Ephemeral Environments page. | ||
| - Enter a name for the environment. | ||
|
|
||
| The environment will now be created in the Not Provisioned state, ready to be provisioned and deployed to. Provisioning will be performed automatically by the configured runbook when the environment is deployed to. |
There was a problem hiding this comment.
Slight tweak to mention the release being deployed here:
| The environment will now be created in the Not Provisioned state, ready to be provisioned and deployed to. Provisioning will be performed automatically by the configured runbook when the environment is deployed to. | |
| The environment will now be created in the Not Provisioned state, ready for a release to be deployed to it. Provisioning will be performed automatically by the configured runbook when a release is deployed to the environment. |
| To update an existing ephemeral environment, create another release that results in the same environment name based on the template. The release will be automatically deployed into the environment. | ||
| ### Automatic Deployments | ||
|
|
||
| Create another release that results in the same environment name based on the environment name template. |
There was a problem hiding this comment.
It's implied that we'll automatically deploy the release, but prob still good to include the explicit text I think to make it super clear what will happen.
| Create another release that results in the same environment name based on the environment name template. | |
| Create another release that results in the same environment name based on the environment name template. The release will be automatically deployed into the environment. |
|
|
||
| ### Automatic deprovisioning of environments | ||
|
|
||
| Ephemeral environments can be automatically deprovisioned if they are inactive after after a configurable time period. Deploying a release to an environment or running a runbook against an environment marks the environment as still being active. |
There was a problem hiding this comment.
Oops, good pickup, thanks!
|
|
||
| ### Manual Deployments | ||
|
|
||
| Create a new release and select the environment to deploy to. |
There was a problem hiding this comment.
Maybe something like:
Create another release and if the environment name template resolves to the same name, Octopus reuses that environment and deploys the new release to it. @geofflamrock @lourens-octopus
|
|
||
| ### Manual Deployments | ||
|
|
||
| Create a new release and select the environment to deploy to. |
There was a problem hiding this comment.
Maybe something like:
Create a new release, then deploy it and select the existing environment in the Deploy to step.
Octopus deploys the release to that environment without creating a new one. @geofflamrock @lourens-octopus
3 participants
[sc-124381]
Add automatic deployments to the ephemeral environments page